Salesforce UX API
TMF-702 updatePrimaryEsimSubscriptionTransferStatus
This operation is to submit the Subscription Transfer Status back to SES for Primary Devices
https://[localhost]:[port]/sfdc-ux/v1/{businessId}/resourceAttributeValueChangeEventurl Param
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one is "PR"-Puerto Rico | Y |
Header
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
| channelId | string | This is to identify the source (Project). Value : BUS sfdc-b2c Conditionally Mandatory. It is Mandatory only for B2B and B2C as there are underlying conditions based on channelId received | Y* |
| targetSystem | string | This is to identify the target system. Value : SES | Y* Y for B2B |
Request
{
"eventId": "updatePrimaryEsimSubscriptionTransferStatus",
"correlationId": "uniqueId",
"eventType": "ResourceAttributeValueChangeEvent",
"event": {
"resource": {
"id": "8613912344719", //PrimaryMSISDN Required
"name": "MSISDN",
"href": "/sfdc-ux/v1/resourceAttributeValueChangeEvent",
"resourceRelationship": [
{
"relationshipType": "current profile",
"resource": {
"id": "460019871234210", //Old IMSI Required
"name": "imsi",
"href": "/sfdc-ux/v1/resourceAttributeValueChangeEvent",
"resourceRelationship": [
{
"relationshipType": "targets",
"resource": {
"id": "8986010110231170983S",
"name": "deviceType",
"description": "iphone",
"category": "eid",
"href": "/sfdc-ux/v1/resourceAttributeValueChangeEvent"
}
}
],
"resourceCharacteristic": [
{
"name": "operatorId",
"valueType": "String",
"value": "operatorA"
},
{
"name": "subscriptionStatus",
"valueType": "String",
"value": "Active"
},
{
"name": "iccidProfile",
"valueType": "object",
"value": {
"imei": "356979067872692", //Old IMEI Required
"iccid": "356935435417269",
"meid": "356935562525632",
"iccidStatus": "Installed"
}
}
]
}
},
{
"relationshipType": "new profile",
"resource": {
"id": "460019871234299",
"name": "imsi",
"href": "/sfdc-ux/v1/resourceAttributeValueChangeEvent",
"resourceRelationship": [
{
"relationshipType": "targets",
"resource": {
"id": "8986010110231170985S",
"name": "device Type",
"description": "iphone",
"category": "eid",
"href": "/sfdc-ux/v1/resourceAttributeValueChangeEvent"
}
}
],
"resourceCharacteristic": [
{
"name": "primaryMsisdn",
"valueType": "String",
"value": "8613912344719"
},
{
"name": "operatorId",
"valueType": "String",
"value": "operatorA"
},
{
"name": "subscriptionStatus",
"valueType": "String",
"value": "Active"
},
{
"name": "iccidProfile",
"valueType": "object",
"value": {
"imei": "356979067872692", //New IMEI Required
"iccid": "35693543541770", //New ICCID Required
"meid": "356935562525632",
"iccidStatus": "Installed"
}
}
]
}
}
]
}
}
}
Definitions
Each of the request parameters is detailed.
| Name | Type | Description | Required |
|---|---|---|---|
| eventId | string | name of event value: "updatePrimaryEsimSubscriptionTransferStatus" | Y |
| correlationId | string | unique id of correlation | N |
| eventType | string | type of event value: "ResourceAttributeValueChangeEvent" | Y |
| event | object | event object | Y |
| resource | object | event resource object | Y |
| event.resource.id | string | value of resource Example: value of MSISDN | Y |
| event.resource.name | string | name of the resource Value: "MSISDN" | Y |
| event.resource.href | string | the URI of the object | N |
| event.resource.resourceRelationship | array object | resource relationship of event resource | Y |
| event.resource.resourceRelationship.relationshipType | string | type of resource relationship Value: "current profile" or "new profile" | Y |
| event.resource.resourceRelationship.resource | string | resource of resource relationship | Y |
| event.resource.resourceRelationship.resource.id | string | resource identifier Example: value of imsi | Y |
| event.resource.resourceRelationship.resource.name | string | name of resource identifier Value: "imsi" | Y |
| event.resource.resourceRelationship.resource.href | string | the URI of the object | Y |
| event.resource.resourceRelationship.resource.resourceRelationship | array object | resource relationship of event resource | Y |
| event.resource.resourceRelationship.resource.resourceRelationship.relationshipType | string | type of resource relationship value: "targets" | Y |
| event.resource.resourceRelationship.resource.resourceRelationship.resource.id | string | resource relationship resource identifier example: value of eid | Y |
| event.resource.resourceRelationship.resource.resourceRelationship.resource.name | string | resource relationship resource name Value: "deviceType" | N |
| event.resource.resourceRelationship.resource.resourceRelationship.resource.description | string | resource relationship resource description Example: value of device type | N |
| event.resource.resourceRelationship.resource.resourceRelationship.resource.category | string | resource relationship resource category Value: "eid" | N |
| event.resource.resourceRelationship.resource.resourceRelationship.resource.href | string | the URI of the object | Y |
| event.resource.resourceRelationship.resource.resourceCharacteristic | array object | resource characteristic | Y |
| event.resource.resourceRelationship.resource.resourceCharacteristic.name | string | name of resource characteristic Example: "operatorId" or "subscriptionStatus" or "iccidProfile" | Y |
| event.resource.resourceRelationship.resource.resourceCharacteristic.valueType | string | value type of resource characteristic Example: "String" or "Object" | N |
| event.resource.resourceRelationship.resource.resourceCharacteristic.value | string/object | value of resource characteristic | N |
| event.resource.resourceRelationship.resource.resourceCharacteristic.value.imei | string | Value of imei | Y |
| event.resource.resourceRelationship.resource.resourceCharacteristic.value.iccid | string | value of iccid | Y |
| event.resource.resourceRelationship.resource.resourceCharacteristic.value.meid | string | value of meid | N |
| event.resource.resourceRelationship.resource.resourceCharacteristic.value.iccidStatus | string | value of iccidStatus | N |
| event.resource.resourceRelationship.resource.resourceCharacteristic.value.state | string | value of state | N |
Response
200- ok.
{}